<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html>
        <head>
          <title>BM25WithGlobalIDFSimilarity - it.agilelab.bigdata.spark.search.impl.similarities.BM25WithGlobalIDFSimilarity</title>
          <meta name="description" content="BM25WithGlobalIDFSimilarity - it.agilelab.bigdata.spark.search.impl.similarities.BM25WithGlobalIDFSimilarity" />
          <meta name="keywords" content="BM25WithGlobalIDFSimilarity it.agilelab.bigdata.spark.search.impl.similarities.BM25WithGlobalIDFSimilarity" />
          <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
          
      <link href="../../../../../../../lib/template.css" media="screen" type="text/css" rel="stylesheet" />
      <link href="../../../../../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css" />
      <script type="text/javascript">
         if(top === self) {
            var url = '../../../../../../../index.html';
            var hash = 'it.agilelab.bigdata.spark.search.impl.similarities.BM25WithGlobalIDFSimilarity';
            var anchor = window.location.hash;
            var anchor_opt = '';
            if (anchor.length >= 1)
              anchor_opt = '@' + anchor.substring(1);
            window.location.href = url + '#' + hash + anchor_opt;
         }
   	  </script>
    
        </head>
        <body class="type">
      <div id="definition">
        <img src="../../../../../../../lib/class_big.png" />
        <p id="owner"><a href="../../../../../../package.html" class="extype" name="it">it</a>.<a href="../../../../../package.html" class="extype" name="it.agilelab">agilelab</a>.<a href="../../../../package.html" class="extype" name="it.agilelab.bigdata">bigdata</a>.<a href="../../../package.html" class="extype" name="it.agilelab.bigdata.spark">spark</a>.<a href="../../package.html" class="extype" name="it.agilelab.bigdata.spark.search">search</a>.<a href="../package.html" class="extype" name="it.agilelab.bigdata.spark.search.impl">impl</a>.<a href="package.html" class="extype" name="it.agilelab.bigdata.spark.search.impl.similarities">similarities</a></p>
        <h1>BM25WithGlobalIDFSimilarity</h1>
      </div>

      <h4 id="signature" class="signature">
      <span class="modifier_kind">
        <span class="modifier"></span>
        <span class="kind">class</span>
      </span>
      <span class="symbol">
        <span class="name">BM25WithGlobalIDFSimilarity</span><span class="result"> extends <span class="extype" name="org.apache.lucene.search.similarities.BM25Similarity">BM25Similarity</span></span>
      </span>
      </h4>
      
          <div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Variant of ClassicSimilarity supporting global IDF using a map for IDF values of terms.
The key for the first map is the field name; the one for the second map is the term; the value is the IDF for the
term in that field.
</p></div><div class="toggleContainer block">
          <span class="toggle">Linear Supertypes</span>
          <div class="superTypes hiddenContent"><span class="extype" name="org.apache.lucene.search.similarities.BM25Similarity">BM25Similarity</span>, <span class="extype" name="org.apache.lucene.search.similarities.Similarity">Similarity</span>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div>
        </div></div>
        

      <div id="mbrsel">
        <div id="textfilter"><span class="pre"></span><span class="input"><input id="mbrsel-input" type="text" accesskey="/" /></span><span class="post"></span></div>
        <div id="order">
              <span class="filtertype">Ordering</span>
              <ol>
                
                <li class="alpha in"><span>Alphabetic</span></li>
                <li class="inherit out"><span>By inheritance</span></li>
              </ol>
            </div>
        <div id="ancestors">
                <span class="filtertype">Inherited<br />
                </span>
                <ol id="linearization">
                  <li class="in" name="it.agilelab.bigdata.spark.search.impl.similarities.BM25WithGlobalIDFSimilarity"><span>BM25WithGlobalIDFSimilarity</span></li><li class="in" name="org.apache.lucene.search.similarities.BM25Similarity"><span>BM25Similarity</span></li><li class="in" name="org.apache.lucene.search.similarities.Similarity"><span>Similarity</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li>
                </ol>
              </div><div id="ancestors">
            <span class="filtertype"></span>
            <ol>
              <li class="hideall out"><span>Hide All</span></li>
              <li class="showall in"><span>Show all</span></li>
            </ol>
            <a href="http://docs.scala-lang.org/overviews/scaladoc/usage.html#members" target="_blank">Learn more about member selection</a>
          </div>
        <div id="visbl">
            <span class="filtertype">Visibility</span>
            <ol><li class="public in"><span>Public</span></li><li class="all out"><span>All</span></li></ol>
          </div>
      </div>

      <div id="template">
        <div id="allMembers">
        <div id="constructors" class="members">
              <h3>Instance Constructors</h3>
              <ol><li name="it.agilelab.bigdata.spark.search.impl.similarities.BM25WithGlobalIDFSimilarity#&lt;init&gt;" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
      <a id="&lt;init&gt;(globalIdf:Map[String,Map[String,Float]]):it.agilelab.bigdata.spark.search.impl.similarities.BM25WithGlobalIDFSimilarity"></a>
      <a id="&lt;init&gt;:BM25WithGlobalIDFSimilarity"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier"></span>
        <span class="kind">new</span>
      </span>
      <span class="symbol">
        <span class="name">BM25WithGlobalIDFSimilarity</span><span class="params">(<span name="globalIdf">globalIdf: <span class="extype" name="scala.Predef.Map">Map</span>[<span class="extype" name="scala.Predef.String">String</span>, <span class="extype" name="scala.Predef.Map">Map</span>[<span class="extype" name="scala.Predef.String">String</span>, <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Float" class="extype" target="_top">Float</a>]]</span>)</span>
      </span>
      </h4>
      
    </li></ol>
            </div>

        

        

        <div id="values" class="values members">
              <h3>Value Members</h3>
              <ol><li name="scala.AnyRef#!=" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="!=(x$1:AnyRef):Boolean"></a>
      <a id="!=(AnyRef):Boolean"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span title="gt4s: $bang$eq" class="name">!=</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
    </li><li name="scala.Any#!=" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="!=(x$1:Any):Boolean"></a>
      <a id="!=(Any):Boolean"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span title="gt4s: $bang$eq" class="name">!=</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
    </li><li name="scala.AnyRef###" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="##():Int"></a>
      <a id="##():Int"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span title="gt4s: $hash$hash" class="name">##</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Int" class="extype" target="_top">Int</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
    </li><li name="scala.AnyRef#==" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="==(x$1:AnyRef):Boolean"></a>
      <a id="==(AnyRef):Boolean"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span title="gt4s: $eq$eq" class="name">==</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
    </li><li name="scala.Any#==" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="==(x$1:Any):Boolean"></a>
      <a id="==(Any):Boolean"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span title="gt4s: $eq$eq" class="name">==</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
    </li><li name="scala.Any#asInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="asInstanceOf[T0]:T0"></a>
      <a id="asInstanceOf[T0]:T0"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span class="extype" name="scala.Any.asInstanceOf.T0">T0</span></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
    </li><li name="org.apache.lucene.search.similarities.BM25Similarity#avgFieldLength" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="avgFieldLength(x$1:org.apache.lucene.search.CollectionStatistics):Float"></a>
      <a id="avgFieldLength(CollectionStatistics):Float"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier"></span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">avgFieldLength</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="org.apache.lucene.search.CollectionStatistics">CollectionStatistics</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Float" class="extype" target="_top">Float</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../../../../org$apache$lucene$search$similarities.html" class="extype" name="org.apache.lucene.search.similarities">org.apache.lucene.search.similarities</a>] </dd><dt>Definition Classes</dt><dd>BM25Similarity</dd></dl></div>
    </li><li name="scala.AnyRef#clone" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="clone():Object"></a>
      <a id="clone():AnyRef"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier"></span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">clone</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.AnyRef">AnyRef</span></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
                <span class="name">@throws</span><span class="args">(<span>
      
      <span class="defval" name="classOf[java.lang.CloneNotSupportedException]">...</span>
    </span>)</span>
              
        </dd></dl></div>
    </li><li name="org.apache.lucene.search.similarities.BM25Similarity#computeNorm" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="computeNorm(x$1:org.apache.lucene.index.FieldInvertState):Long"></a>
      <a id="computeNorm(FieldInvertState):Long"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">computeNorm</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="org.apache.lucene.index.FieldInvertState">FieldInvertState</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Long" class="extype" target="_top">Long</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>BM25Similarity → Similarity</dd></dl></div>
    </li><li name="org.apache.lucene.search.similarities.BM25Similarity#computeWeight" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="computeWeight(x$1:org.apache.lucene.search.CollectionStatistics,x$2:&lt;repeated...&gt;[org.apache.lucene.search.TermStatistics]):org.apache.lucene.search.similarities.Similarity.SimWeight"></a>
      <a id="computeWeight(CollectionStatistics,&lt;repeated...&gt;[TermStatistics]):SimWeight"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">computeWeight</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="org.apache.lucene.search.CollectionStatistics">CollectionStatistics</span></span>, <span name="arg1">arg1: <span class="extype" name="scala.&lt;repeated...&gt;">&lt;repeated...&gt;</span>[<span class="extype" name="org.apache.lucene.search.TermStatistics">TermStatistics</span>]</span>)</span><span class="result">: <span class="extype" name="org.apache.lucene.search.similarities.Similarity.SimWeight">SimWeight</span></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>BM25Similarity → Similarity</dd></dl></div>
    </li><li name="org.apache.lucene.search.similarities.Similarity#coord" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="coord(x$1:Int,x$2:Int):Float"></a>
      <a id="coord(Int,Int):Float"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier"></span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">coord</span><span class="params">(<span name="arg0">arg0: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Int" class="extype" target="_top">Int</a></span>, <span name="arg1">arg1: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Int" class="extype" target="_top">Int</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Float" class="extype" target="_top">Float</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Similarity</dd></dl></div>
    </li><li name="org.apache.lucene.search.similarities.BM25Similarity#decodeNormValue" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="decodeNormValue(x$1:Byte):Float"></a>
      <a id="decodeNormValue(Byte):Float"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier"></span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">decodeNormValue</span><span class="params">(<span name="arg0">arg0: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Byte" class="extype" target="_top">Byte</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Float" class="extype" target="_top">Float</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../../../../org$apache$lucene$search$similarities.html" class="extype" name="org.apache.lucene.search.similarities">org.apache.lucene.search.similarities</a>] </dd><dt>Definition Classes</dt><dd>BM25Similarity</dd></dl></div>
    </li><li name="org.apache.lucene.search.similarities.BM25Similarity#encodeNormValue" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="encodeNormValue(x$1:Float,x$2:Int):Byte"></a>
      <a id="encodeNormValue(Float,Int):Byte"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier"></span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">encodeNormValue</span><span class="params">(<span name="arg0">arg0: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Float" class="extype" target="_top">Float</a></span>, <span name="arg1">arg1: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Int" class="extype" target="_top">Int</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Byte" class="extype" target="_top">Byte</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../../../../org$apache$lucene$search$similarities.html" class="extype" name="org.apache.lucene.search.similarities">org.apache.lucene.search.similarities</a>] </dd><dt>Definition Classes</dt><dd>BM25Similarity</dd></dl></div>
    </li><li name="scala.AnyRef#eq" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="eq(x$1:AnyRef):Boolean"></a>
      <a id="eq(AnyRef):Boolean"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">eq</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
    </li><li name="scala.AnyRef#equals" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="equals(x$1:Any):Boolean"></a>
      <a id="equals(Any):Boolean"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier"></span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
    </li><li name="scala.AnyRef#finalize" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="finalize():Unit"></a>
      <a id="finalize():Unit"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier"></span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">finalize</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
                <span class="name">@throws</span><span class="args">(<span>
      
      <span class="symbol">classOf[java.lang.Throwable]</span>
    </span>)</span>
              
        </dd></dl></div>
    </li><li name="org.apache.lucene.search.similarities.BM25Similarity#getB" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="getB():Float"></a>
      <a id="getB():Float"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">getB</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Float" class="extype" target="_top">Float</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>BM25Similarity</dd></dl></div>
    </li><li name="scala.AnyRef#getClass" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="getClass():Class[_]"></a>
      <a id="getClass():Class[_]"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">getClass</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.Class">Class</span>[_]</span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
    </li><li name="org.apache.lucene.search.similarities.BM25Similarity#getDiscountOverlaps" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="getDiscountOverlaps():Boolean"></a>
      <a id="getDiscountOverlaps():Boolean"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier"></span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">getDiscountOverlaps</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>BM25Similarity</dd></dl></div>
    </li><li name="org.apache.lucene.search.similarities.BM25Similarity#getK1" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="getK1():Float"></a>
      <a id="getK1():Float"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">getK1</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Float" class="extype" target="_top">Float</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>BM25Similarity</dd></dl></div>
    </li><li name="scala.AnyRef#hashCode" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="hashCode():Int"></a>
      <a id="hashCode():Int"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier"></span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">hashCode</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Int" class="extype" target="_top">Int</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
    </li><li name="it.agilelab.bigdata.spark.search.impl.similarities.BM25WithGlobalIDFSimilarity#idf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="idf(docFreq:Long,docCount:Long):Float"></a>
      <a id="idf(Long,Long):Float"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier"></span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">idf</span><span class="params">(<span name="docFreq">docFreq: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Long" class="extype" target="_top">Long</a></span>, <span name="docCount">docCount: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Long" class="extype" target="_top">Long</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Float" class="extype" target="_top">Float</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="it.agilelab.bigdata.spark.search.impl.similarities.BM25WithGlobalIDFSimilarity">BM25WithGlobalIDFSimilarity</a> → BM25Similarity</dd></dl></div>
    </li><li name="it.agilelab.bigdata.spark.search.impl.similarities.BM25WithGlobalIDFSimilarity#idfExplain" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="idfExplain(collectionStats:org.apache.lucene.search.CollectionStatistics,termStats:Array[org.apache.lucene.search.TermStatistics]):org.apache.lucene.search.Explanation"></a>
      <a id="idfExplain(CollectionStatistics,Array[TermStatistics]):Explanation"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier"></span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">idfExplain</span><span class="params">(<span name="collectionStats">collectionStats: <span class="extype" name="org.apache.lucene.search.CollectionStatistics">CollectionStatistics</span></span>, <span name="termStats">termStats: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Array" class="extype" target="_top">Array</a>[<span class="extype" name="org.apache.lucene.search.TermStatistics">TermStatistics</span>]</span>)</span><span class="result">: <span class="extype" name="org.apache.lucene.search.Explanation">Explanation</span></span>
      </span>
      </h4>
      <p class="shortcomment cmt">Computes a score factor for a phrase.</p><div class="fullcomment"><div class="comment cmt"><p>Computes a score factor for a phrase.</p><p>The default implementation sums the idf factor for
each term in the phrase.
</p></div><dl class="paramcmts block"><dt class="param">collectionStats</dt><dd class="cmt"><p>collection-level statistics</p></dd><dt class="param">termStats</dt><dd class="cmt"><p>term-level statistics for the terms in the phrase</p></dd><dt>returns</dt><dd class="cmt"><p>an Explain object that includes both an idf
        score factor for the phrase and an explanation
        for each term.
</p></dd></dl><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="it.agilelab.bigdata.spark.search.impl.similarities.BM25WithGlobalIDFSimilarity">BM25WithGlobalIDFSimilarity</a> → BM25Similarity</dd></dl></div>
    </li><li name="it.agilelab.bigdata.spark.search.impl.similarities.BM25WithGlobalIDFSimilarity#idfExplain" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="idfExplain(collectionStats:org.apache.lucene.search.CollectionStatistics,termStats:org.apache.lucene.search.TermStatistics):org.apache.lucene.search.Explanation"></a>
      <a id="idfExplain(CollectionStatistics,TermStatistics):Explanation"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier"></span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">idfExplain</span><span class="params">(<span name="collectionStats">collectionStats: <span class="extype" name="org.apache.lucene.search.CollectionStatistics">CollectionStatistics</span></span>, <span name="termStats">termStats: <span class="extype" name="org.apache.lucene.search.TermStatistics">TermStatistics</span></span>)</span><span class="result">: <span class="extype" name="org.apache.lucene.search.Explanation">Explanation</span></span>
      </span>
      </h4>
      <p class="shortcomment cmt">Computes a score factor for a simple term and returns an explanation
for that score factor.</p><div class="fullcomment"><div class="comment cmt"><p>Computes a score factor for a simple term and returns an explanation
for that score factor.</p><p>The default implementation uses:</p><p><pre class="prettyprint">
idf(docFreq, docCount);
</pre></p><p>Note that <code> CollectionStatistics#docCount()</code> is used instead of
<code> org.apache.lucene.index.IndexReader#numDocs() IndexReader#numDocs()</code> because also
<code> TermStatistics#docFreq()</code> is used, and when the latter
is inaccurate, so is <code> CollectionStatistics#docCount()</code>, and in the same direction.
In addition, <code> CollectionStatistics#docCount()</code> does not skew when fields are sparse.
</p></div><dl class="paramcmts block"><dt class="param">collectionStats</dt><dd class="cmt"><p>collection-level statistics</p></dd><dt class="param">termStats</dt><dd class="cmt"><p>term-level statistics for the term</p></dd><dt>returns</dt><dd class="cmt"><p>an Explain object that includes both an idf score factor
        and an explanation for the term.
</p></dd></dl><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="" class="extype" name="it.agilelab.bigdata.spark.search.impl.similarities.BM25WithGlobalIDFSimilarity">BM25WithGlobalIDFSimilarity</a> → BM25Similarity</dd></dl></div>
    </li><li name="scala.Any#isInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="isInstanceOf[T0]:Boolean"></a>
      <a id="isInstanceOf[T0]:Boolean"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">isInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
    </li><li name="scala.AnyRef#ne" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="ne(x$1:AnyRef):Boolean"></a>
      <a id="ne(AnyRef):Boolean"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">ne</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
    </li><li name="scala.AnyRef#notify" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="notify():Unit"></a>
      <a id="notify():Unit"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">notify</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
    </li><li name="scala.AnyRef#notifyAll" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="notifyAll():Unit"></a>
      <a id="notifyAll():Unit"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">notifyAll</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
    </li><li name="org.apache.lucene.search.similarities.Similarity#queryNorm" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="queryNorm(x$1:Float):Float"></a>
      <a id="queryNorm(Float):Float"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier"></span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">queryNorm</span><span class="params">(<span name="arg0">arg0: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Float" class="extype" target="_top">Float</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Float" class="extype" target="_top">Float</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Similarity</dd></dl></div>
    </li><li name="org.apache.lucene.search.similarities.BM25Similarity#scorePayload" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="scorePayload(x$1:Int,x$2:Int,x$3:Int,x$4:org.apache.lucene.util.BytesRef):Float"></a>
      <a id="scorePayload(Int,Int,Int,BytesRef):Float"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier"></span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">scorePayload</span><span class="params">(<span name="arg0">arg0: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Int" class="extype" target="_top">Int</a></span>, <span name="arg1">arg1: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Int" class="extype" target="_top">Int</a></span>, <span name="arg2">arg2: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Int" class="extype" target="_top">Int</a></span>, <span name="arg3">arg3: <span class="extype" name="org.apache.lucene.util.BytesRef">BytesRef</span></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Float" class="extype" target="_top">Float</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../../../../org$apache$lucene$search$similarities.html" class="extype" name="org.apache.lucene.search.similarities">org.apache.lucene.search.similarities</a>] </dd><dt>Definition Classes</dt><dd>BM25Similarity</dd></dl></div>
    </li><li name="org.apache.lucene.search.similarities.BM25Similarity#setDiscountOverlaps" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="setDiscountOverlaps(x$1:Boolean):Unit"></a>
      <a id="setDiscountOverlaps(Boolean):Unit"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier"></span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">setDiscountOverlaps</span><span class="params">(<span name="arg0">arg0: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Boolean" class="extype" target="_top">Boolean</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>BM25Similarity</dd></dl></div>
    </li><li name="org.apache.lucene.search.similarities.BM25Similarity#simScorer" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="simScorer(x$1:org.apache.lucene.search.similarities.Similarity.SimWeight,x$2:org.apache.lucene.index.LeafReaderContext):org.apache.lucene.search.similarities.Similarity.SimScorer"></a>
      <a id="simScorer(SimWeight,LeafReaderContext):SimScorer"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">simScorer</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="org.apache.lucene.search.similarities.Similarity.SimWeight">SimWeight</span></span>, <span name="arg1">arg1: <span class="extype" name="org.apache.lucene.index.LeafReaderContext">LeafReaderContext</span></span>)</span><span class="result">: <span class="extype" name="org.apache.lucene.search.similarities.Similarity.SimScorer">SimScorer</span></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>BM25Similarity → Similarity</dd><dt>Annotations</dt><dd>
                <span class="name">@throws</span><span class="args">(<span>
      
      <span class="symbol">classOf[java.io.IOException]</span>
    </span>)</span>
              
        </dd></dl></div>
    </li><li name="org.apache.lucene.search.similarities.BM25Similarity#sloppyFreq" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="sloppyFreq(x$1:Int):Float"></a>
      <a id="sloppyFreq(Int):Float"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier"></span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">sloppyFreq</span><span class="params">(<span name="arg0">arg0: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Int" class="extype" target="_top">Int</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Float" class="extype" target="_top">Float</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../../../../org$apache$lucene$search$similarities.html" class="extype" name="org.apache.lucene.search.similarities">org.apache.lucene.search.similarities</a>] </dd><dt>Definition Classes</dt><dd>BM25Similarity</dd></dl></div>
    </li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="synchronized[T0](x$1:=&gt;T0):T0"></a>
      <a id="synchronized[T0](⇒T0):T0"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: ⇒ <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>)</span><span class="result">: <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
    </li><li name="org.apache.lucene.search.similarities.BM25Similarity#toString" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="toString():String"></a>
      <a id="toString():String"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier"></span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>BM25Similarity → AnyRef → Any</dd></dl></div>
    </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="wait():Unit"></a>
      <a id="wait():Unit"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">wait</span><span class="params">()</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
                <span class="name">@throws</span><span class="args">(<span>
      
      <span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
    </span>)</span>
              
        </dd></dl></div>
    </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="wait(x$1:Long,x$2:Int):Unit"></a>
      <a id="wait(Long,Int):Unit"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">wait</span><span class="params">(<span name="arg0">arg0: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Long" class="extype" target="_top">Long</a></span>, <span name="arg1">arg1: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Int" class="extype" target="_top">Int</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
                <span class="name">@throws</span><span class="args">(<span>
      
      <span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
    </span>)</span>
              
        </dd></dl></div>
    </li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
      <a id="wait(x$1:Long):Unit"></a>
      <a id="wait(Long):Unit"></a>
      <h4 class="signature">
      <span class="modifier_kind">
        <span class="modifier">final </span>
        <span class="kind">def</span>
      </span>
      <span class="symbol">
        <span class="name">wait</span><span class="params">(<span name="arg0">arg0: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Long" class="extype" target="_top">Long</a></span>)</span><span class="result">: <a href="http://www.scala-lang.org/api/2.10.6/index.html#scala.Unit" class="extype" target="_top">Unit</a></span>
      </span>
      </h4>
      <div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
                <span class="name">@throws</span><span class="args">(<span>
      
      <span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
    </span>)</span>
              
        </dd></dl></div>
    </li></ol>
            </div>

        

        
        </div>

        <div id="inheritedMembers">
        <div class="parent" name="org.apache.lucene.search.similarities.BM25Similarity">
              <h3>Inherited from <span class="extype" name="org.apache.lucene.search.similarities.BM25Similarity">BM25Similarity</span></h3>
            </div><div class="parent" name="org.apache.lucene.search.similarities.Similarity">
              <h3>Inherited from <span class="extype" name="org.apache.lucene.search.similarities.Similarity">Similarity</span></h3>
            </div><div class="parent" name="scala.AnyRef">
              <h3>Inherited from <span class="extype" name="scala.AnyRef">AnyRef</span></h3>
            </div><div class="parent" name="scala.Any">
              <h3>Inherited from <span class="extype" name="scala.Any">Any</span></h3>
            </div>
        
        </div>

        <div id="groupedMembers">
        <div class="group" name="Ungrouped">
              <h3>Ungrouped</h3>
              
            </div>
        </div>

      </div>

      <div id="tooltip"></div>

      <div id="footer">  </div>
      <script defer="defer" type="text/javascript" id="jquery-js" src="../../../../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" id="jquery-ui-js" src="../../../../../../../lib/jquery-ui.js"></script><script defer="defer" type="text/javascript" id="tools-tooltip-js" src="../../../../../../../lib/tools.tooltip.js"></script><script defer="defer" type="text/javascript" id="template-js" src="../../../../../../../lib/template.js"></script>
    </body>
      </html>